home *** CD-ROM | disk | FTP | other *** search
/ Chip 1998 November / CHIP Kasım 1998.iso / emulators / nintendo / nestcxxxdos.exe / README.TXT < prev   
Text File  |  2000-01-01  |  15KB  |  418 lines
  1. =================================================================
  2.  NESticle                                 Version x.xx (xx/xx/xx)
  3.  by Bloodlust Software
  4. =================================================================
  5.  
  6. Email: bldlust@maelstrom.net
  7.  
  8. Death to the defiler.
  9.  
  10. Do not send any files without asking first.
  11.  
  12. Do not ask about SNESticle (or anything else you want emulated).
  13.  
  14. ---------------------
  15.      What it is
  16. ---------------------
  17.  
  18. NESticle is a DOS/Win95 based emulator for the Nintendo
  19. Entertainment System written in C++/Assembly.
  20.  
  21. It is freeware and it is not to be distributed with game
  22. ROMs and it is not to be modified or sold.
  23.  
  24. A majority of the NES technical information used to create this
  25. came from Marat Fayzullin's (fms@freeflight.com) great NES.DOC.
  26.  
  27. Sound information was provided by AJG, Fanwen, Mikael Iushin and Y0SHi.
  28.  
  29. ---------------------
  30.      Revisions
  31. ---------------------
  32.  
  33. Version x.xx:
  34.  - ????
  35.  
  36. ---------------------
  37.     What it does
  38. ---------------------
  39.  
  40. NESticle emulates the basic NES hardware, along with several of
  41. the memory mapping chips used by various games. 
  42.  
  43. What's emulated:
  44.  
  45.    -6502 CPU
  46.    -PPU
  47.    -VRAM/VROM
  48.    -Horizontal/Vertical mirroring
  49.    -Scrolling
  50.    -8x8 and 8x16 Sprites
  51.    -Dual joypads
  52.    -iNES Memory mappers fully/partially supported: 
  53.       0,1,2,3,4,5,6,7,8,9,11,15,19,22,23,32
  54.    -Battery backed RAM
  55.    -Sound emulation
  56.  
  57. Other neat features:
  58.  
  59.    -Multiple save states
  60.    -Joystick/"GrIP" support
  61.    -Network play (Win95 exe only)
  62.    -"Friendly" GUI
  63.    -VESA/DirectDraw support
  64.    -Fullscreen 256x224 VGA mode (DOS only)
  65.    -Save .pcx snapshots
  66.    -Editable pattern tables (CHR/tile/vrom)
  67.    -iNES single file cart format
  68.    -Wave output loggable
  69.    -Editable palette (I dont have the correct colors)
  70.  
  71.  
  72. ---------------------
  73.  What it doesn't do
  74. ---------------------
  75.  
  76. Lightgun
  77.  
  78. Mapper/compatibility problems
  79.  
  80. Palette changes during frame (W&W, Startropics)
  81.  
  82.  
  83. ---------------------
  84.   What you need
  85. ---------------------
  86.  
  87. A 486 or Pentium running DOS or Windows 95/NT.
  88.  
  89. The DOS version requires DOS4GW, available separately.
  90.  
  91. For the Windows version you MUST HAVE DirectX Version 3.0.
  92. It's available somewhere on Microsoft's labyrinth of a website.
  93. At least 16MB of memory for the Win95 version.
  94.  
  95. NESticle can take advantage of VESA 2.0 support if it exists.
  96. If it does not exist, NESticle will resort to only the
  97. video modes 320x200, 256x224, 256x240, 256x256.
  98. 256x256 has scanlines.
  99. You need about 8MB of memory for the DOS version.
  100.  
  101. The DOS version supports true Soundblasters ONLY.
  102. The Win95 version utilizes DirectSound for digital output.
  103.  
  104. ---------------------
  105.  How to work it
  106. ---------------------
  107.  
  108. Load up a .NES rom from the File/Load ROM.
  109. Reset the rom from CPU/Reset.
  110.  
  111. If you're running in a high-res mode (>320x240), the NES
  112. game screen will appear in a window. You can maximize the window
  113. with the "SQUARE" button in the title bar. You close the window with
  114. the X button.
  115.  
  116. You can toggle the GUI on and off by pressing ESC.
  117.  
  118. You change the input devices from the Settings/RedefineInput menu(s).
  119. No matter what the settings are, Enter/Tab are always Start/Select in order
  120. to accomodate 2 button joysticks. Enter/Tab only work if the game window
  121. has input focus (click on it) or the gui is disabled.
  122.  
  123. F5/F7 saves and loads your games. Essentially it stores the entire NES state
  124. in a state file. Pressing the keyboard keys 0-9 (not the numeric keypad ones)
  125. will change the current state slot for subsequent saves/loads:
  126.    0 = "xxxx.STA"        (xxxx is the rom file name)
  127.    1 = "xxxx.ST1"
  128.    2 = "xxxx.ST2"
  129.      ... etc
  130. The default slot whenever a rom is loaded is 0 (ie "xxxx.STA")
  131. With statebackuping on, when saving, the old state file is renamed to 
  132. 'xxxx.bak'. You'll have to manually rename the backup state file to
  133. use it again.
  134.  
  135. You can record movies with CPU/NES Movie/Record. This will create
  136. a NES Movie file (*.nsm) which contains the NES state along with
  137. recorded input.
  138.  
  139. To edit patterns, View/Pattern tables, then click on a pattern and edit it.
  140. Right clicking on a pattern will change its attribute (palette), to aid
  141. in drawing. If you wish, you can save the changes with File/Write VROM, and the
  142. VROM will be written directly to the .NES file, so beware.
  143.  
  144.  
  145. ---------------------
  146.   ROMS and stuff
  147. ---------------------
  148.  
  149. NESticle currently uses the iNES single file cart format (*.NES).
  150. The ROMs must be stored in the same dir as the .exe.
  151.  
  152. Here's a description of a sample cart 'ZELDA' and some possible extensions:
  153.  
  154.  - ZELDA.NES
  155.     The actual ROM/VROM data preceded by a 16-byte header
  156.  
  157.  - ZELDA.HDR
  158.     An alternate 16-byte header file. If NESticle encounters this in the dir
  159.     of the ROM, it will use this header instead of the one present in the
  160.     NES file.
  161.  
  162.  - ZELDA.SAV
  163.     8K file representing the contents of the battery backed memory used
  164.     in some games. This file is automagically saved and loaded as needed.
  165.  
  166.  - ZELDA.ST?
  167.     It's the 'state' file used by saved games.
  168.  
  169.  - ZELDA.NSM
  170.     Recorded NES Movie.
  171.  
  172.  - ZELDA.PAT
  173.     Text file containing ROM patches
  174.  
  175.  
  176. ---------------------
  177. ROM patching/GameGenie
  178. ---------------------
  179.  
  180. I finally deciphered GameGenie codes with some basic info provided
  181. by Benzene of Digital Emutations (demu@wspice.com). No thanks to Galoob.
  182.  
  183. NESticle supports GameGenie codes and general patching of the
  184. CPU ROM address space ($8000-$FFFF).
  185.  
  186. Bring up the ROM patching dialog with F6 or from the CPU menu.
  187. There are two edit fields in the dialog, the Name and the Code.
  188. The Code field is where the actual code goes (eg APZLGG). 
  189. The Name field lets you type in a description of the code (eg Megajump),
  190. if no name is entered then the code string is used as the name.
  191. Once you've filled these in, clicking "Add" (or pressing enter) will 
  192. add it to the list of patches. To activate or deactivate the patch, 
  193. doubleclick on the code name in the listbox or click on "Toggle".
  194. "Remove" deletes the patch completely. "Save" writes all the patches
  195. to the text file <romname>.pat, this file is decribed below.
  196.  
  197. NESticle accepts either GameGenie codes or raw patches.
  198. GameGenie codes can be either 6 or 8 digits and
  199. use the letters:
  200.     A P Z L G I T Y   E O X U K S V N
  201. Deciphering the GameGenie code is a mess and I won't
  202. go into it here. NESticle internally converts them to a raw format.
  203.  
  204. The raw patches have two formats that coorespond to both
  205. types of Game Genie codes:
  206.  
  207.         <$addr>:<$val>          (6 letter GG code)
  208.         <$addr>?<$key>:<$val>   (8 letter GG code)
  209.  
  210. <$addr> is a 15-bit hex address within $8000-$FFFF of 
  211.           the CPU address space (the rom area).
  212. <$val> is the 8-bit hex value to be patched at that address.
  213. <$key> is an 8-bit hex number that MUST be present at that
  214.           ROM location before the patch will be active.
  215.  
  216. Examples:
  217.  10A4:10    patches CPU address $90A4 with the hex value $10.
  218.  05A1?5B:FF patches CPU address $85A1 with the hex value $FF if 
  219.              and only if $85A1 currently contains $5B
  220.  
  221. NESticle can save a .pat file that contains all the patches
  222. created during a game. This file can be modified using a
  223. text editor. Each line of the .pat file looks like this:
  224.  
  225.           [+]<code> [<name>]
  226.  
  227. [+]    if a '+' is prefixed to the code, then it will be automatically
  228.         activated when the game is run
  229. <code> is the patch itself (GG 6/8 or raw format).
  230. <name> is the text description of the code, if no name is supplied
  231.         then the code is used as the name
  232.  
  233. Note: If more than one patch modifies the same address (and have compatible
  234. keys) then only one can be active at once. Activating one will deactivate
  235. the others (ie they are mutually exclusive).
  236.  
  237.  
  238.  
  239. ---------------------
  240.    Input Devices
  241. ---------------------
  242.  
  243. NESticle supports analog joysticks, 4-button gamepads,
  244. the Gravis GrIP gameport and keyboard input.
  245.  
  246. Some general things:
  247.  - There are two input devices, one each for NES controller 1 and 2.
  248.  - Change the input devices with Settings/RedefineInput
  249.  - Enter/Tab will simulate Start/Select on NES controller 1, ONLY when
  250.     the GUI is disabled or the NES game window has input focus (click on it)
  251.  - You can remap the buttons for a joystick input device with the 
  252.     command line option '-remapbut' or from the "Remap buttons" dialog...
  253.     Simply click on the NES button type and then press the joystick button 
  254.     you wish to use. Pressing any key will set the NES button to "None".
  255.  - You can redefine the keys for a Keyboard input device with the 
  256.     Redefine Keys dialog, or with the '-setkey' command line option
  257.  
  258. Under DOS:
  259.  - Joystick 1 or 2 refer to 2-button analog joysticks only!
  260.  - "Gamepad" refers to a 4-button analog joypad (or joystick)
  261.    The default button mapping for "Gamepad" conforms to that
  262.    for a Gravis Gamepad (ie, 0 2 1 3), but can be changed
  263.  - Due to hardware limits, only one 4-button device can be connected
  264.  - You can interactively calibrate the joystick with the "Calibrate" 
  265.    button. Just center and swirl. The joystick thresholds can be also
  266.    set with the '-joythresh' command line option.
  267.  - In order to enable GrIP support, you MUST copy the "grip.gll" file
  268.     to NESticle's startup directory. NESticle will load the driver
  269.     if it finds it and the GrIP devices in slot 1 or 2 can be used.
  270.  - For the MS Sidewinder to work in digital mode under Win95, you must
  271.     have v1.5 of the MS Sidewinder software and you must press the
  272.     mode button a few times.
  273.  
  274. Under Win95:
  275.  - Joystick 1 and 2 refer to joystick device 1 and 2 as defined under
  276.     Win95's Control Panel/Joystick and can be calibrated from there
  277.  - Gamepad refers to joystick device 1 (with the default Gravis Gamepad mapping)
  278.  - Under Win95 there is no practical limit to the number of buttons
  279.     per joystick device, and any can be remapped
  280.  
  281. GrIP support was added via Gravis's SDK, however it doesn't seem to 
  282. work with other devices besides the GrIP Gameport. I dont know why.
  283.  
  284. ---------------------
  285. Command line options
  286. ---------------------
  287.  
  288. DOS & WIN95:
  289. ------------
  290.  
  291. @<filename>     : Parses the file <filename> for command line options
  292.  
  293. -res <xw> <yw>  : Sets the resolution to xw,yw on startup.
  294.                 : Use this if 256x224 doesn't work or you get a
  295.                 : "Unable to init DDraw: invalid mode" error
  296.  
  297. -setinput <num> <type>
  298.                 : Sets input device <num> to <type>
  299.                    ex. '-setinput 1 GRAVIS'
  300. -remapbut <device> <b> <a> <sel> <start>
  301.                 : Remaps buttons for <device>
  302.                 : <device> can be JOY1, JOY2 or GRAVIS
  303.                 : <b>,<a>,<sel>,<start> are the joystick button #'s for each NES button
  304.                 : A setting of '255' will disable the NES button
  305.                 : The old 'swapbut' is now obselete, instead use "-remapbut JOY1 1 0"
  306. -setkey <device> <ul> <u> <ur> <l> <r> <dl> <d> <dr> <b> <a> <sel> <start>
  307.                 : Sets the keyboard scancodes for <device>
  308.                 : <device> can be KEY1 or KEY2
  309. -setjoythresh <num>  <left> <right> <up> <down>
  310.                 : Sets the joystick threshold for analog joystick <num>
  311.                 : left,right,up,down define the joystick's "dead-zone"
  312.  
  313. -vsync <ON/OFF> : Wait for the vertical sync to draw frames (see Performance)
  314. -frameskip <x>  : Sets frameskip (1-8 or "AUTO" for autoskipping)
  315. -hidegui        : Hide GUI on startup
  316. -nomsgpopup     : Disables the last message from popping up on screen
  317.  
  318. -load <rom>     : Load <rom>
  319. -run <rom>      : Load & Run <rom>
  320. -restore <rom>  : Load & Run & Restore state for <rom>
  321.  
  322. -sndrate <rate> : Sets the sound sampling rate (8000-44100) default=22050
  323. -sndblksize <s> : Sets the size of the mixing block (in samples) default=256
  324. -nosound        : Bypasses the initialization of any sound hardware
  325. -force8bit      : Forces 8-bit sound output (even if 16-bit exists)
  326.  
  327. -romdir <dir>   : Sets the startup dir for .NES roms
  328. -savedir <dir>  : Sets the directory for .SAV and .STA files
  329. -pcxdir <dir>   : Sets the directory for saving snapshots
  330. -logdir <dir>   : Sets the directory for logging and debug files
  331. -patchdir <dir> : Sets the directory for .PAT files
  332.  
  333. -swmode <x>     : Sets the MS Sidewinder polling mode
  334.                 : 0=Interrupts disabled, multiple gameport resets  (default)
  335.                 : 1=Interrupts disabled, single gameport reset
  336.                 : 2=Interrupts enabled, multiple gameport resets
  337.                 : 3=Interrupts enabled, single gameport reset
  338.  
  339. DOS only:
  340. ---------
  341. -? or -h        : Display command line help
  342. -disablelfn     : Disables long file name support
  343. -novesa         : Don't use VESA extensions
  344. -linear         : Force linear video mode
  345. -banked         : Force banked video mode
  346.  
  347. -sb   <port> <irq> <dma8>  : Forces 8-bit soundblaster settings (ex -sb 220 7 1)
  348. -sb16 <port> <irq> <dma16> : Forces 16-bit soundblaster settings (ex -sb16 220 5 5)
  349.       (if soundblaster settings are not supplied, they will
  350.         be extracted from the BLASTER environment variable)
  351.  
  352. -rdtsc          : Enable the use of the Pentium RDTSC profiling instruction
  353. -fpucopy        : Use the FPU for mem->vidmem copies (pentium only)
  354.  
  355.  
  356. "NESticle.ini" and "NEStcl95.ini" are two automatically generated
  357. configuration files which are parsed before the command line
  358. itself. You can manually edit the constants in this file if
  359. you wish, but any additional commands or options added to it
  360. will be overwritten the next time you run NESticle.
  361.  
  362. The two files "NESticle.cmd" and "NEStcl95.cmd" are user-editable
  363. files for command line options and will be appended to the
  364. ini files when they are parsed.
  365.  
  366. ---------------------
  367.      Contact
  368. ---------------------
  369.  
  370. bldlust@maelstrom.net
  371. http://???
  372.  
  373. ---------------------
  374.   Acknowledgements
  375. ---------------------
  376.  
  377. Marat Fayzullin for his priceless NES.DOC and iNES emulator.
  378.  
  379. Y0SHi for taking the time to maintain his 'nestech.doc'
  380.  
  381. AJG, Y0SHi, Marat, Mikael Iushin and FanWen for 
  382. supplying valuable information on NES sound.
  383.  
  384. Thanks to Robert William Grubbs for writing his document
  385.  on reading the MS Sidewinder digitally in DOS. 
  386.  
  387. All the drippy folk at dripware software.
  388.  
  389. Additional info:
  390.  FanWen (yangfanw@ms4.hinet.net)
  391.  Neill Corlett
  392.  Andrew Davie (adavie@comcen.com.au)
  393.  Matthew J Richey (mr6v+@andrew.cmu.edu)
  394.  Benzene (demu@wspice.com)
  395.  Neil Bradley (neil@synthcom.com)
  396.  Jens Christian Restemeier
  397.  Benny Boola Hill
  398.  Barkley, DeceiverX, Loopy, Vectriff, Zophar
  399.  
  400. Scrotum-art and testing by digger.
  401.  
  402.  
  403. ---------------------
  404.      Disclaimer
  405. ---------------------
  406.  
  407. NESticle Copyright 1997 Bloodlust Software
  408. Nintendo Entertainment System (NES) is a registered trademark of Nintendo.
  409. Game Genie is a trademark of Galoob.
  410. Neither Bloodlust Software nor the author are affiliated with Nintendo
  411.  nor advocate the piracy of NES games.
  412. NESticle is freeware and can be distributed freely as long as it is not
  413.  modified and ROMs are not packaged with the program.
  414. When you use this software you do so at your own risk. The author is 
  415.  not responsible for any loss or damage resulting from the use or 
  416.  misuse of this software.
  417. If you do not agree with these terms then NESticle is not for you.
  418.